NAV
Shell Ruby Python Javascript

Introduction (example)

Welcome to the Alaunus API! You can use our API to access Alaunus API endpoints, which can get information on stuff in our database.

We have language bindings in Shell, Ruby, and Python! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Authentication (example)

To authorize, use this code:

require 'Kittn'

api = Kittn::APIClient.authorize!('meowmeowmeow')
import kittn

api = kittn.authorize('meowmeowmeow')
# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
  -H "Authorization: meowmeowmeow"
const kittn = require('kittn');

let api = kittn.authorize('meowmeowmeow');

Make sure to replace meowmeowmeow with your API key.

Kittn uses API keys to allow access to the API. You can register a new Kittn API key at our developer portal.

Kittn expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: meowmeowmeow

Patients (example)

Patients section:

require 'Kittn'

api = Kittn::APIClient.authorize!('meowmeowmeow')
import kittn

api = kittn.authorize('meowmeowmeow')
# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
  -H "Authorization: meowmeowmeow"
const kittn = require('kittn');

let api = kittn.authorize('meowmeowmeow');

test

Kittens (example)

Get All Kittens (example)

dasdastens

require 'kittn'

api = Kittn::APIClient.authorize!('meowmeowmeow')
api.kittens.get
import kittn

api = kittn.authorize('meowmeowmeow')
api.kittens.get()
import kittn

api = kittn.authorize('meowmeowmeow')
api.kittens.get()
import kittn

api = kittn.authorize('meowmeowmeow')
api.kittens.get()
import kittn

api = kittn.authorize('meowmeowmeow')
api.kittens.get()
import kittn

api = kittn.authorize('meowmeowmeow')
api.kittens.get()
import kittn

api = kittn.authorize('meowmeowmeow')
api.kittens.get()
import kittn

api = kittn.authorize('meowmeowmeow')
api.kittens.get()
import kittn

api = kittn.authorize('meowmeowmeow')
api.kittens.get()
curl "http://example.com/api/kittens"
  -H "Authorization: meowmeowmeow"
const kittn = require('kittn');

let api = kittn.authorize('meowmeowmeow');
let kittens = api.kittens.get();

The above command returns JSON structured like this:

[
  {
    "id": 1,
    "name": "Fluffums",
    "breed": "calico",
    "fluffiness": 6,
    "cuteness": 7
  },
  {
    "id": 2,
    "name": "Max",
    "breed": "unknown",
    "fluffiness": 5,
    "cuteness": 10
  }
]

This endpoint retrieves all kittens.

HTTP Request

GET http://example.com/api/kittens

Query Parameters

Parameter Default Description
include_cats false If set to true, the result will also include cats.
available true If set to false, the result will include kittens that have already been adopted.

Get a Specific Kitten (example)

require 'kittn'

api = Kittn::APIClient.authorize!('meowmeowmeow')
api.kittens.get(2)
import kittn

api = kittn.authorize('meowmeowmeow')
api.kittens.get(2)
curl "http://example.com/api/kittens/2"
  -H "Authorization: meowmeowmeow"
const kittn = require('kittn');

let api = kittn.authorize('meowmeowmeow');
let max = api.kittens.get(2);

The above command returns JSON structured like this:

{
  "id": 2,
  "name": "Max",
  "breed": "unknown",
  "fluffiness": 5,
  "cuteness": 10
}

This endpoint retrieves a specific kitten.

HTTP Request

GET http://example.com/kittens/<ID>

URL Parameters

Parameter Description
ID The ID of the kitten to retrieve

Accounts

The accounts object

Attributes:

Attribute
Type
Description
This contains the created date
This contains the account id number
integer
If the account is active or not
subdocument
Contains all the billing settings, like how is the billing going to happen, what happens with late checkouts and others
subdocument
Contains all information on employee candidates, like stage, description, hr information and more
string
Retrieves the email data
subdocuments
Contains the emergency phones and its informations
string
Contains the external id
string
Contains the HST number
subdocument
Contains all the invoice settings, like the sales rep for example.
subdocuments
Location info, like address and geolocation
file
Company logo
subdocument
Name of the company
subdocument
Contains all the payroll settings, like the type of payroll, the period and others
file
The company's policy
subdocument
This contains the settings for each role inside the company
subdocuments
Contains information about the roles, like for example the type, color and all the permissions
subdocuments
Contains information on the sales reps, like his or hers name, office, nickname and others
subdocument
Contains all the scheduler settings, like duration and permissions for example
subdocuments
Contains the services and its informations, like its code, description, pay rate and others
subdocument
Contains settings like the timezone, currency used, country, language and others
subdocuments
Contains the taxes info, like the amount and its label
subdocument
Contains the telephony information, like the authentication token, errors and others
subdocuments
Contains the company's terms
subdocument
Contains all the visit settings, like punchcards, gps, overrides and telephony
string
Contains the company's website
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'

Candidates

The candidates object

Attributes:

Attribute
Type
Description
subdocuments
Contains the date in which the candidate was deleted and its reasons
boolean
If candidate was hired or not
datetime
Date in which the candidate was hired
id
User that hired
subdocument
What are the days and hours that the candidate is available during the week
subdocuments
Notes on the candidate
id
What is the status of the candidate, applied, phone screened, selected for interview, interviewd or hired
subdocuments
What are the certifications of the candidate
id
How are the cleaning skills of the candidate
id
How are the cooking skills of the candidate
string
Candidate's cover letter
boolean
If the candidate was a criminal offender
string
In case the candidate was a criminal offender, what was the reason
date
Contains the date of birth of the candidate
id
Contains information on the candidate's drivers licence, if the candidate has one or not and others
id
This contains the level of education of the candidate
string
Contains the email of the candidate
subdocuments
This contains the employment history of the candidate, previous jobs, duration and etc
id
How many years of experiece the candidate has
subdocument
Information on which range of ages the candidate has experience with
string
Contains the external id
id
Contains the gender of the candidate
boolean
If the candidate is okay with pets
boolean
If the candidate is okay with smokers
subdocuments
Contains the languages spoken by the candidate and which one is the primary language
id
Living status of the candidate
subdocuments
Location info, like address and geolocation
id
Manager info
subdocument
Name of the candidate
string
The nearest intersection to the candidate
subdocuments
Information on the candidate's phones, like numbers and types
integer
Contains the rating on the candidate
string
Candidate's resume
subdocument
What are the salary expectations of the candidate
subdocuments
What are the candidate's skills
id
Candidate's source
id
How are the swimming skills of the candidate
id
Contains the method of transportation of the candidate, if it is by bus or car for example
boolean
If the candidate has a valid travel passport or not
id
If the candidate is okay with pets, which kind of pets
boolean
If the candidate has a US travel visa or not
boolean
If the candidate is willing to travel or not
id
What is the type of work permit of the candidate
subdocument
Contains information on the candidate work status, if it is full time, part time, temp or on call
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'

Clients

The clients object

Attributes:

Attribute
Type
Description
string
Contains the accounting id
string
Color of the tag
subdocument
Company's name and website
subdocument
Information on the client, like name, phones and gender
id
Type of client, if it is company or person
string
Contains the email of the client
subdocuments
Contains information on the employees, like their names, offices, emails and others
string
Contains the external id
subdocuments
Location info, like address and geolocation
id
Type of client, if it is company or person
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'

Contacts

The contacts object

Attributes:

Attribute
Type
Description
id
Type of contact, if it is company or person
string
Contains the accounting id
subdocument
Company's name and website
subdocument
Information on the client, like name, phones and gender
string
Contains the email of the contact
string
Contains the external id
subdocument
Contains the fax number of the contact
subdocuments
Location info, like address and geolocation
string
Notes on the contact
file
Photo of the contact
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'

Conversations

The conversations object

Attributes:

Attribute
Type
Description
subdocument
Form whom the message comes
subdocuments
The message info
subdocuments
To whom the message will be sent
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'

Events

The events object

Attributes:

Attribute
Type
Description
Information on the user that created this event
id
Group of events
datetime
When was the event last updated
id
Which user last updated the event
subdocuments
Information on who are the attendees on the event, like name, pay_rate and others
subdocument
Information on the billing, like billing period, currency, payment method and others
float
Information on the duration of the event
datetime
When does the event ends
subdocument
Expectation on the bill amount
subdocument
Location where the event is going to start with information like address and geolocation
subdocument
Location where the event is going to end with information like address and geolocation
string
Notes on the event
subdocument
Information on the patient
subdocument
Information on the services that apply for this event, like pay rate and others
datetime
Start of the event
boolean
If it was on a holiday
id
Status of the event
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'

Eventsgroups

The eventsgroups object

Attributes:

Attribute
Type
Description
array
If the event is grouped by month
array
If the event is grouped by week
integer
How many times the event happens
date
Date the event group started
datetime
Dante the event group ends
subdocument
The ends of the event
array
All the events in that group of events
string
The frequency in which the event repeats
integer
The interval in which the event happens
datetime
When the group of events start
datetime
Until when the group of events is supposed to happen
string
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'

Files

The files object

Attributes:

Attribute
Type
Description
datetime
Date in which the file was uploaded
string
Checksum number in order to detect errors on the file
string
Type of the content of the file
string
The file
string
Name of the file
string
Notes on the file
id
Type of the file
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'

Invoices

The invoices object

Attributes:

Attribute
Type
Description
boolean
If the invoice is closed or not
datetime
Date in which the invoice was closed in case it was closed
id
User that closed the invoice
subdocument
Information on the account, like name, location and website
float
How much is due to be paid
float
How much was paid
subdocument
What is the billing period
date
Date in which the billing period ends
date
Date in which the billing period starts
subdocument
Credit card invoice
string
Contains the number of the claim
subdocument
Information on the client, like for example type, id, email, phone and others
id
Currency used
date
When it is due
string
Message on the footer
string
Email used for the invoice
string
Message on the header
string
Contains the HST number
date
Date of the invoice
id
Type of the invoice
string
Information on the legal rep
date
Date of loss
id
Method used for the invoice
string
Notes on the invoice
string
Invoice number
subdocument
Information on the patient, with email, name, location, phone and others
id
Method used for the payment
subdocuments
Punchcards information, with bill and others
subdocument
By whom it was referred
subdocument
Contains information on the sales rep, like his or hers name, office, nickname and others
subdocuments
Contains the services and its informations, like its code, description, pay rate and others
id
Status of the invoice
float
Invoice's subtotal
float
Total taxes
subdocuments
Contains the taxes info, like the amount and its label
id
Invoice template
subdocument
Invoice's term
float
Invoice's total
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'

Patients

The patients object

Attributes:

Attribute
Type
Description
subdocuments
Contains the date in which the patient was deleted and its reasons
string
Contains the accounting id
subdocuments
Contains all the billing info, like how is the billing period and others
id
Information on the case coordinator for that patient
subdocument
Credit card account of the patient
string
Patient's chart ID
subdocument
Patient's checklist
id
What are the cleaning skills the patient is expecting
subdocuments
Emergency contacts with phone number and etc
id
What are the cooking skills the patient is expecting
date
Date of birth of the patient
id
This contains the level of education the patient expects
string
Contains the email of the patient
id
Ethnicity of the patient
id
Number of years of experience expected by the patient
subdocument
Experience with range of years expected
subdocuments
Files about the patient
id
Gender of the patient
string
Notes on the patient
boolean
If the patient has pets
string
Notes on the patient
boolean
If the patient is a smoker
subdocuments
Languages spoken by the patient
string
Information on the legal rep
id
Living status of the patient
subdocuments
Location info, like address and geolocation
string
The major intersection to the candidate
id
Marital status of the patient
subdocument
Name of the patient
subdocuments
Notes on the patient
subdocuments
All patient's phone numbers and its types
file
Photo of the patient
subdocuments
Patient's problems
id
Who referred that patient
id
Patient's religion
subdocument
How much is the salary
subdocument
Service date range
subdocuments
All the services necessary by the patient
string
SSN nuber
date
Date in which the ssn expiry
id
Patient's status
id
What are the swimming skills the patient is expecting
id
What kind of transportation is the patient expecting
boolean
If patient requires a valid travel passport
id
If the patient has pets, what are the kind of pets
boolean
If patient requires a valid US visa
id
Education level required by the patient
boolean
If patient will be travelling
subdocument
Work status required by tge patient
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'

Patientsprogressnotes

The patientsprogressnotes object

Attributes:

Attribute
Type
Description
Date in which the progress note was created
Which user created the progress note
If it was deleted
datetime
Last date note was updated
id
Last user that updated the note
subdocument
If it was approved and the date
subdocument
For whom is the invoice
string
The note itself
id
Patient ID
id
Patient's services
id
The priority of the note
boolean
If the note is private or not
id
Who referred
id
The service that was tagged
subdocuments
Tags of the note
string
The title of the note
subdocuments
Tagged users on the note
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'

Payments

The payments object

Attributes:

Attribute
Type
Description
float
Amount paid
id
Who made the payment
datetime
Date of the payment
id
Invoice for the payment
string
Notes on the payment
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'

Payrolls

The payrolls object

Attributes:

Attribute
Type
Description
boolean
If payroll was closed or not
datetime
Date when payroll was closed
id
User that closed the payroll
date
End date
integer
Extra period
id
Type of the period
date
Start date
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'

Payrollsusers

The payrollsusers object

Attributes:

Attribute
Type
Description
The date it was created
The user that created it
subdocuments
ADjustments information
id
Payroll information
array
Punchcards information, with bill and others
subdocument
User information, like name, nickname and others
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'

Punchcards

The punchcards object

Attributes:

Attribute
Type
Description
subdocument
Punchcard's event
subdocument
Actual information, with actual date and others
subdocument
Punchcard's bill
subdocument
All billing info on the punchcards
id
Punchcard's event ID
subdocument
Punchcard's invoice
subdocument
Punchcard's location
subdocument
The end location for that punchcard
subdocument
Patient on the punchcard
subdocument
All the paying information on that punchcard
subdocument
Payroll on the punchcard
subdocument
Information about the service on that punchcard
boolean
If it is or not an statutory holiday
subdocument
The user on that punchcard and his or hers information
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'

Skills

The skills object

Attributes:

Attribute
Type
Description
string
Color of the skill
string
Description of the skill
string
Title of the skill
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'

Tags

The tags object

Attributes:

Attribute
Type
Description
string
Color of the tag
string
Description of the tag
string
Title of the tag
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'

Users

The users object

Attributes:

Attribute
Type
Description
id
Contains the candidate id
User was deleted
subdocuments
Contains the date in which the user was deleted and its reasons
datetime
Date in which the user was set
boolean
User was suspended
datetime
Contains the date in which the user was suspended
id
Who suspended that user
string
This contains the accounting id number
subdocument
Days and hours in which the user is available
subdocuments
Certifications of the user, like school, university and etc
id
How are the cleaning skills of the user
id
How are the cooking skills of the user
boolean
If the user was a criminal offender
string
In case the user was a criminal offender, what was the reason
date
Date of birth of the user
id
Contains information on the user's drivers licence, if the user has one or not and others
id
This contains the level of education of the user
string
Contains the user email
subdocuments
This contains the employment history of the user, previous jobs, duration and etc
id
How many years of experiece the user has
subdocument
Information on which range of ages the user has experience with
string
Contains the user external ID
subdocuments
Any files on the user
id
User's gender
boolean
If the user is okay with pets
datetime
Date in which the user was invited
boolean
If the user is set up
boolean
If the user is okay with smokers
subdocuments
Languages spoken by the user, with information on which one is his or hers primary language
datetime
Last time user logged in
id
Living status of the user
subdocuments
Location info, like address and geolocation
id
Manager info
subdocument
Name of the user
string
The nearest intersection to the user
subdocuments
Information on the user's phones, like numbers and types
file
User's photo
id
Role of the user
id
Type of role
subdocument
What are the salary expectations of the user
subdocuments
Services provided by the user
subdocuments
What are the user's skills
id
User's source
string
SSN number
date
SSN expiry date
date
Date in which the user started
id
How are the swimming skills of the user
id
Timezone of the user
id
Contains the method of transportation of the user, if it is by bus or car for example
boolean
If the user has a valid travel passport or not
id
If the user is okay with pets, which kind of pets
boolean
If the user has a US travel visa or not
boolean
If the user is willing to travel or not
id
What is the type of work permit of the user
subdocument
Contains information on the user work status, if it is full time, part time, temp or on call
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'

Usersnotes

The usersnotes object

Attributes:

Attribute
Type
Description
Date in which the note was created
Which user created the note
If it was deleted
datetime
Last date note was updated
id
Last user that updated the note
string
The note itself
id
The priority of the note
string
The title of the note
id
User ID
require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get
dsja javascript
dsja javascript
print 'Hello, world!'
sads shell
import test
 
api = test.authorize('key')
api.test.get()
curl 'http://example.com/api/test'
  -H 'Authorization: key'